alandtse / alexa_media_player

This is a custom component to allow control of Amazon Alexa devices in Home Assistant using the unofficial Alexa API.
Apache License 2.0
1.35k stars 263 forks source link

Alexa Media Player fails to initialize after restarting HA 2024.6.3 due to partitioned cookie #2288

Open danielbrunt57 opened 2 weeks ago

danielbrunt57 commented 2 weeks ago

IMPORTANT: Please search the issues, including closed issues, and the FAQ before opening a new issue. The template is mandatory; failure to use it will result in issue closure.

Describe the bug

Alexa Media Player is failing to initialize after restarting HA 2024.6.3. If I reload the integration, all is well.

To Reproduce

Restart Home assistant 2014.6.3 and observe that the integration failed to load.

Expected behavior

It should load like it did on 2024.6.2 and older.

Screenshots

image

System details

Logs

home-assistant_2024-06-17T13-08-27.618Z.log

Additional context

thenoid commented 2 weeks ago

Seeing the same thing. though, here is my pip output

Name: AlexaPy
Version: 1.27.10
Summary: Python API to control Amazon Echo Devices Programmatically.
Home-page: https://gitlab.com/keatontaylor/alexapy
Author: Keaton Taylor
Author-email: keatonstaylor@gmail.com
License: Apache-2.0
Location: /usr/local/lib/python3.12/site-packages
Requires: aiofiles, aiohttp, authcaptureproxy, backoff, beautifulsoup4, certifi, cryptography, httpx, pyotp, requests, simplejson, yarl
Required-by:
xhemp commented 2 weeks ago

Mine does't work even after reloading it. HA 2024.6.3

meute commented 2 weeks ago

I have the same issue, I need to manually reload integration after each restart, reload seems to work each time.

quietsnow commented 2 weeks ago

Same issue. Reloading works for me too.

danielbrunt57 commented 2 weeks ago

My workaround for now is this automation:

alias: Reload Alexa Media Player after HA starts
description: ""
trigger:
  - platform: homeassistant
    event: start
condition: []
action:
  - delay:
      hours: 0
      minutes: 1
      seconds: 0
      milliseconds: 0
  - alias: Reload Alexa Media Player integration
    service: homeassistant.reload_config_entry
    data: {}
    target:
      entity_id: media_player.bedroom
    enabled: true
mode: single
alandtse commented 2 weeks ago

Please note this has been in the FAQ for years. https://github.com/alandtse/alexa_media_player/wiki/FAQ#modulenotfounderror-no-module-named-alexapy

thenoid commented 2 weeks ago

But now it's happening on every restart ever since the upgrade. That FAQ entry only mentions "on upgrade". Implying the first time. Not every time.

xhemp commented 2 weeks ago

I removed the pickle file from .storage, removed the integration, re-added and it's working fine.

From the FAQ:

The login cookie may have expired. Delete your alexa_media.(email).pickle from your configuration directory and restart HA. If you're uncomfortable deleting it, rename it to alexa_media.pickle.old so you can restore it.

@quietsnow FYI

danielbrunt57 commented 2 weeks ago

@alandtse

Please note this has been in the FAQ for years. https://github.com/alandtse/alexa_media_player/wiki/FAQ#modulenotfounderror-no-module-named-alexapy

I followed your link and...

homeassistant:/config# pip3 install alexapy
Looking in indexes: https://pypi.org/simple, https://wheels.home-assistant.io/musllinux-index/
Requirement already satisfied: alexapy in /usr/local/lib/python3.12/site-packages (1.27.10)

I removed the pickle file, removed and re-installed the integration but my problem after HA restart still exists...

2024-06-18 15:11:26.699 ERROR (MainThread) [homeassistant.config_entries] Error setting up entry daniel@brunt.ca - amazon.com for alexa_media
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/config_entries.py", line 594, in async_setup
    result = await component.async_setup_entry(hass, self)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/config/custom_components/alexa_media/__init__.py", line 335, in async_setup_entry
    await login.login(cookies=await login.load_cookie())
                              ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/alexapy/alexalogin.py", line 328, in load_cookie
    cookies = pickle.loads(await myfile.read())
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/http/cookies.py", line 312, in __setitem__
    raise CookieError("Invalid attribute %r" % (K,))
http.cookies.CookieError: Invalid attribute 'partitioned'

image

image

image

image

hiagocosta commented 2 weeks ago

i'm facing the same issue here

thenoid commented 2 weeks ago

Yeah please re-open this issue. It's not a 1 time occurrence anymore and is every restart.

KennethLavrsen commented 2 weeks ago

I also have this issue. The integration fails to start every time I restart HA. And it succeed to load by reloading the integration. The error is always

Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/config_entries.py", line 594, in async_setup
    result = await component.async_setup_entry(hass, self)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/config/custom_components/alexa_media/__init__.py", line 335, in async_setup_entry
    await login.login(cookies=await login.load_cookie())
                              ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/alexapy/alexalogin.py", line 328, in load_cookie
    cookies = pickle.loads(await myfile.read())
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/http/cookies.py", line 312, in __setitem__
    raise CookieError("Invalid attribute %r" % (K,))
http.cookies.CookieError: Invalid attribute 'partitioned'

The issue started about 1-2 weeks ago. I never experienced this before.

carvan commented 2 weeks ago

Hi all - same here

2024-06-19 11:55:13.878 INFO (MainThread) [custom_components.alexa_media] Loaded alexapy==1.27.10
2024-06-19 11:55:13.878 DEBUG (MainThread) [custom_components.alexa_media.helpers] v********i@g*******m: Returning uuid {'uuid': 'xxxxxxxxxxxxxxxxxxxxxxxxxx', 'index': 0}
2024-06-19 11:55:13.895 DEBUG (MainThread) [alexapy.alexalogin] Login created for omitted - amazon.it
2024-06-19 11:55:13.895 DEBUG (MainThread) [alexapy.alexalogin] Searching for cookies from /config/.storage/alexa_media.omitted.pickle
2024-06-19 11:55:13.895 DEBUG (MainThread) [alexapy.alexalogin] Trying to load cookie from file /config/.storage/alexa_media.omitted.pickle
2024-06-19 11:55:13.897 ERROR (MainThread) [homeassistant.config_entries] Error setting up entry omitted - amazon.it for alexa_media
Traceback (most recent call last):
  File "/usr/src/homeassistant/homeassistant/config_entries.py", line 594, in async_setup
    result = await component.async_setup_entry(hass, self)
             ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/config/custom_components/alexa_media/__init__.py", line 335, in async_setup_entry
    await login.login(cookies=await login.load_cookie())
                              ^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/site-packages/alexapy/alexalogin.py", line 328, in load_cookie
    cookies = pickle.loads(await myfile.read())
              ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/usr/local/lib/python3.12/http/cookies.py", line 312, in __setitem__
    raise CookieError("Invalid attribute %r" % (K,))
http.cookies.CookieError: Invalid attribute 'partitioned'
therealcarnivor commented 2 weeks ago

I just went back from HA 2014.6.3 to 2014.6.2 and it started up no problem

GlenWi commented 2 weeks ago

I am also having this same issue. Using the automation work-around from danielbrunt57 until it's fixed. Thanks.

jouster1974 commented 2 weeks ago

same issue here...renaming old pickle file didnt help unfortunately

xbmcnut commented 2 weeks ago

For me, renaming the .pickle file and deleting the integration worked as this forced a re-authentication when adding the integration back in. Have not restarted since doing that so unsure if it's persistent.

danielbrunt57 commented 2 weeks ago

I just went back from HA 2014.6.3 to 2014.6.2 and it started up no problem

I just reverted to 2024.6.2 and confirm that it is working correctly. It's just 2024.6.3 that has the issue.

danielbrunt57 commented 2 weeks ago

Have not restarted since doing that so unsure if it's persistent.

If you're running 2024.6.3, the integration will fail to initialize after HA restarts.

NordFreak commented 2 weeks ago

i have the same problem

danielbrunt57 commented 2 weeks ago

I just now re-upgraded to HA 2024.6.3 and after restarting the first time, Alexa Media Player initialized just fine but upon subsequent restarts is failing to initialize.

nathanm412 commented 2 weeks ago

It looks like PR #119621 did change the media_player platform to load earlier than it did in 2024.6.2.

danielbrunt57 commented 1 week ago

I don't think the media_player platform is at all related/relevant. This though might be: Support for Partitioned cookies attribute #112713

danielbrunt57 commented 1 week ago

I've found a solution which is working for me. My issue seems to be in alexapy which is using python 3.12. It's cookies.py does not define partitioned in the cookie dictionary, which for some reason is what my setup is encountering during first initialization after restart but not during a reload. I found this PR: gh-112713 : Add support for 'partitioned' attribute in http.cookies #112714 which has been approved for python 3.13 but hasn't been finalized yet and still has to go through several betas before official ETA release in October. This would seem to be needed now as MS Edge (my default browser) seems to already be creating partitioned cookies (CHIPS) and I've read that Google Chrome recently started rolling it out as well.

First, edit config/custom_components/alexa_media/manifest.json and add "websocket_api" to "dependencies":

{
  "domain": "alexa_media",
  "name": "Alexa Media Player",
  "codeowners": ["@alandtse", "@keatontaylor"],
  "config_flow": true,
  "dependencies": ["persistent_notification", "http", "websocket_api"],
  "documentation": "https://github.com/alandtse/alexa_media_player/wiki",
  "iot_class": "cloud_polling",
  "issue_tracker": "https://github.com/alandtse/alexa_media_player/issues",
  "loggers": ["alexapy", "authcaptureproxy"],
  "requirements": ["alexapy==1.27.10", "packaging>=20.3", "wrapt>=1.14.0"],
  "version": "4.10.2"
}

Then, in the homeassistant container, I replaced /usr/local/lib/python3.12/http/cookies.py with the newer python3.13 cookies.py file from https://github.com/giles-v/cpython/blob/add-cookies-partitioned-support/Lib/http/cookies.py (Line 285 is where "partitioned" has been added to the cookie dictionary):

####
# Copyright 2000 by Timothy O'Malley <timo@alum.mit.edu>
#
#                All Rights Reserved
#
# Permission to use, copy, modify, and distribute this software
# and its documentation for any purpose and without fee is hereby
# granted, provided that the above copyright notice appear in all
# copies and that both that copyright notice and this permission
# notice appear in supporting documentation, and that the name of
# Timothy O'Malley  not be used in advertising or publicity
# pertaining to distribution of the software without specific, written
# prior permission.
#
# Timothy O'Malley DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
# SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
# AND FITNESS, IN NO EVENT SHALL Timothy O'Malley BE LIABLE FOR
# ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
# WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
# WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS
# ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
# PERFORMANCE OF THIS SOFTWARE.
#
####
#
# Id: Cookie.py,v 2.29 2000/08/23 05:28:49 timo Exp
#   by Timothy O'Malley <timo@alum.mit.edu>
#
#  Cookie.py is a Python module for the handling of HTTP
#  cookies as a Python dictionary.  See RFC 2109 for more
#  information on cookies.
#
#  The original idea to treat Cookies as a dictionary came from
#  Dave Mitchell (davem@magnet.com) in 1995, when he released the
#  first version of nscookie.py.
#
####

r"""
Here's a sample session to show how to use this module.
At the moment, this is the only documentation.

The Basics
----------

Importing is easy...

   >>> from http import cookies

Most of the time you start by creating a cookie.

   >>> C = cookies.SimpleCookie()

Once you've created your Cookie, you can add values just as if it were
a dictionary.

   >>> C = cookies.SimpleCookie()
   >>> C["fig"] = "newton"
   >>> C["sugar"] = "wafer"
   >>> C.output()
   'Set-Cookie: fig=newton\r\nSet-Cookie: sugar=wafer'

Notice that the printable representation of a Cookie is the
appropriate format for a Set-Cookie: header.  This is the
default behavior.  You can change the header and printed
attributes by using the .output() function

   >>> C = cookies.SimpleCookie()
   >>> C["rocky"] = "road"
   >>> C["rocky"]["path"] = "/cookie"
   >>> print(C.output(header="Cookie:"))
   Cookie: rocky=road; Path=/cookie
   >>> print(C.output(attrs=[], header="Cookie:"))
   Cookie: rocky=road

The load() method of a Cookie extracts cookies from a string.  In a
CGI script, you would use this method to extract the cookies from the
HTTP_COOKIE environment variable.

   >>> C = cookies.SimpleCookie()
   >>> C.load("chips=ahoy; vienna=finger")
   >>> C.output()
   'Set-Cookie: chips=ahoy\r\nSet-Cookie: vienna=finger'

The load() method is darn-tootin smart about identifying cookies
within a string.  Escaped quotation marks, nested semicolons, and other
such trickeries do not confuse it.

   >>> C = cookies.SimpleCookie()
   >>> C.load('keebler="E=everybody; L=\\"Loves\\"; fudge=\\012;";')
   >>> print(C)
   Set-Cookie: keebler="E=everybody; L=\"Loves\"; fudge=\012;"

Each element of the Cookie also supports all of the RFC 2109
Cookie attributes.  Here's an example which sets the Path
attribute.

   >>> C = cookies.SimpleCookie()
   >>> C["oreo"] = "doublestuff"
   >>> C["oreo"]["path"] = "/"
   >>> print(C)
   Set-Cookie: oreo=doublestuff; Path=/

Each dictionary element has a 'value' attribute, which gives you
back the value associated with the key.

   >>> C = cookies.SimpleCookie()
   >>> C["twix"] = "none for you"
   >>> C["twix"].value
   'none for you'

The SimpleCookie expects that all values should be standard strings.
Just to be sure, SimpleCookie invokes the str() builtin to convert
the value to a string, when the values are set dictionary-style.

   >>> C = cookies.SimpleCookie()
   >>> C["number"] = 7
   >>> C["string"] = "seven"
   >>> C["number"].value
   '7'
   >>> C["string"].value
   'seven'
   >>> C.output()
   'Set-Cookie: number=7\r\nSet-Cookie: string=seven'

Finis.
"""

#
# Import our required modules
#
import re
import string
import types

__all__ = ["CookieError", "BaseCookie", "SimpleCookie"]

_nulljoin = ''.join
_semispacejoin = '; '.join
_spacejoin = ' '.join

#
# Define an exception visible to External modules
#
class CookieError(Exception):
    pass

# These quoting routines conform to the RFC2109 specification, which in
# turn references the character definitions from RFC2068.  They provide
# a two-way quoting algorithm.  Any non-text character is translated
# into a 4 character sequence: a forward-slash followed by the
# three-digit octal equivalent of the character.  Any '\' or '"' is
# quoted with a preceding '\' slash.
# Because of the way browsers really handle cookies (as opposed to what
# the RFC says) we also encode "," and ";".
#
# These are taken from RFC2068 and RFC2109.
#       _LegalChars       is the list of chars which don't require "'s
#       _Translator       hash-table for fast quoting
#
_LegalChars = string.ascii_letters + string.digits + "!#$%&'*+-.^_`|~:"
_UnescapedChars = _LegalChars + ' ()/<=>?@[]{}'

_Translator = {n: '\\%03o' % n
               for n in set(range(256)) - set(map(ord, _UnescapedChars))}
_Translator.update({
    ord('"'): '\\"',
    ord('\\'): '\\\\',
})

_is_legal_key = re.compile('[%s]+' % re.escape(_LegalChars)).fullmatch

def _quote(str):
    r"""Quote a string for use in a cookie header.

    If the string does not need to be double-quoted, then just return the
    string.  Otherwise, surround the string in doublequotes and quote
    (with a \) special characters.
    """
    if str is None or _is_legal_key(str):
        return str
    else:
        return '"' + str.translate(_Translator) + '"'

_OctalPatt = re.compile(r"\\[0-3][0-7][0-7]")
_QuotePatt = re.compile(r"[\\].")

def _unquote(str):
    # If there aren't any doublequotes,
    # then there can't be any special characters.  See RFC 2109.
    if str is None or len(str) < 2:
        return str
    if str[0] != '"' or str[-1] != '"':
        return str

    # We have to assume that we must decode this string.
    # Down to work.

    # Remove the "s
    str = str[1:-1]

    # Check for special sequences.  Examples:
    #    \012 --> \n
    #    \"   --> "
    #
    i = 0
    n = len(str)
    res = []
    while 0 <= i < n:
        o_match = _OctalPatt.search(str, i)
        q_match = _QuotePatt.search(str, i)
        if not o_match and not q_match:              # Neither matched
            res.append(str[i:])
            break
        # else:
        j = k = -1
        if o_match:
            j = o_match.start(0)
        if q_match:
            k = q_match.start(0)
        if q_match and (not o_match or k < j):     # QuotePatt matched
            res.append(str[i:k])
            res.append(str[k+1])
            i = k + 2
        else:                                      # OctalPatt matched
            res.append(str[i:j])
            res.append(chr(int(str[j+1:j+4], 8)))
            i = j + 4
    return _nulljoin(res)

# The _getdate() routine is used to set the expiration time in the cookie's HTTP
# header.  By default, _getdate() returns the current time in the appropriate
# "expires" format for a Set-Cookie header.  The one optional argument is an
# offset from now, in seconds.  For example, an offset of -3600 means "one hour
# ago".  The offset may be a floating point number.
#

_weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']

_monthname = [None,
              'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun',
              'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']

def _getdate(future=0, weekdayname=_weekdayname, monthname=_monthname):
    from time import gmtime, time
    now = time()
    year, month, day, hh, mm, ss, wd, y, z = gmtime(now + future)
    return "%s, %02d %3s %4d %02d:%02d:%02d GMT" % \
           (weekdayname[wd], day, monthname[month], year, hh, mm, ss)

class Morsel(dict):
    """A class to hold ONE (key, value) pair.

    In a cookie, each such pair may have several attributes, so this class is
    used to keep the attributes associated with the appropriate key,value pair.
    This class also includes a coded_value attribute, which is used to hold
    the network representation of the value.
    """
    # RFC 2109 lists these attributes as reserved:
    #   path       comment         domain
    #   max-age    secure      version
    #
    # For historical reasons, these attributes are also reserved:
    #   expires
    #
    # This is an extension from Microsoft:
    #   httponly
    #
    # This dictionary provides a mapping from the lowercase
    # variant on the left to the appropriate traditional
    # formatting on the right.
    _reserved = {
        "expires": "expires",
        "path": "Path",
        "comment": "Comment",
        "domain": "Domain",
        "max-age": "Max-Age",
        "secure": "Secure",
        "httponly": "HttpOnly",
        "version": "Version",
        "samesite": "SameSite",
        "partitioned": "Partitioned",
    }

    _flags = {'secure', 'httponly', 'partitioned'}

    def __init__(self):
        # Set defaults
        self._key = self._value = self._coded_value = None

        # Set default attributes
        for key in self._reserved:
            dict.__setitem__(self, key, "")

    @property
    def key(self):
        return self._key

    @property
    def value(self):
        return self._value

    @property
    def coded_value(self):
        return self._coded_value

    def __setitem__(self, K, V):
        K = K.lower()
        if not K in self._reserved:
            raise CookieError("Invalid attribute %r" % (K,))
        dict.__setitem__(self, K, V)

    def setdefault(self, key, val=None):
        key = key.lower()
        if key not in self._reserved:
            raise CookieError("Invalid attribute %r" % (key,))
        return dict.setdefault(self, key, val)

    def __eq__(self, morsel):
        if not isinstance(morsel, Morsel):
            return NotImplemented
        return (dict.__eq__(self, morsel) and
                self._value == morsel._value and
                self._key == morsel._key and
                self._coded_value == morsel._coded_value)

    __ne__ = object.__ne__

    def copy(self):
        morsel = Morsel()
        dict.update(morsel, self)
        morsel.__dict__.update(self.__dict__)
        return morsel

    def update(self, values):
        data = {}
        for key, val in dict(values).items():
            key = key.lower()
            if key not in self._reserved:
                raise CookieError("Invalid attribute %r" % (key,))
            data[key] = val
        dict.update(self, data)

    def isReservedKey(self, K):
        return K.lower() in self._reserved

    def set(self, key, val, coded_val):
        if key.lower() in self._reserved:
            raise CookieError('Attempt to set a reserved key %r' % (key,))
        if not _is_legal_key(key):
            raise CookieError('Illegal key %r' % (key,))

        # It's a good key, so save it.
        self._key = key
        self._value = val
        self._coded_value = coded_val

    def __getstate__(self):
        return {
            'key': self._key,
            'value': self._value,
            'coded_value': self._coded_value,
        }

    def __setstate__(self, state):
        self._key = state['key']
        self._value = state['value']
        self._coded_value = state['coded_value']

    def output(self, attrs=None, header="Set-Cookie:"):
        return "%s %s" % (header, self.OutputString(attrs))

    __str__ = output

    def __repr__(self):
        return '<%s: %s>' % (self.__class__.__name__, self.OutputString())

    def js_output(self, attrs=None):
        # Print javascript
        return """
        <script type="text/javascript">
        <!-- begin hiding
        document.cookie = \"%s\";
        // end hiding -->
        </script>
        """ % (self.OutputString(attrs).replace('"', r'\"'))

    def OutputString(self, attrs=None):
        # Build up our result
        #
        result = []
        append = result.append

        # First, the key=value pair
        append("%s=%s" % (self.key, self.coded_value))

        # Now add any defined attributes
        if attrs is None:
            attrs = self._reserved
        items = sorted(self.items())
        for key, value in items:
            if value == "":
                continue
            if key not in attrs:
                continue
            if key == "expires" and isinstance(value, int):
                append("%s=%s" % (self._reserved[key], _getdate(value)))
            elif key == "max-age" and isinstance(value, int):
                append("%s=%d" % (self._reserved[key], value))
            elif key == "comment" and isinstance(value, str):
                append("%s=%s" % (self._reserved[key], _quote(value)))
            elif key in self._flags:
                if value:
                    append(str(self._reserved[key]))
            else:
                append("%s=%s" % (self._reserved[key], value))

        # Return the result
        return _semispacejoin(result)

    __class_getitem__ = classmethod(types.GenericAlias)

#
# Pattern for finding cookie
#
# This used to be strict parsing based on the RFC2109 and RFC2068
# specifications.  I have since discovered that MSIE 3.0x doesn't
# follow the character rules outlined in those specs.  As a
# result, the parsing rules here are less strict.
#

_LegalKeyChars  = r"\w\d!#%&'~_`><@,:/\$\*\+\-\.\^\|\)\(\?\}\{\="
_LegalValueChars = _LegalKeyChars + r'\[\]'
_CookiePattern = re.compile(r"""
    \s*                            # Optional whitespace at start of cookie
    (?P<key>                       # Start of group 'key'
    [""" + _LegalKeyChars + r"""]+?   # Any word of at least one letter
    )                              # End of group 'key'
    (                              # Optional group: there may not be a value.
    \s*=\s*                          # Equal Sign
    (?P<val>                         # Start of group 'val'
    "(?:[^\\"]|\\.)*"                  # Any doublequoted string
    |                                  # or
    \w{3},\s[\w\d\s-]{9,11}\s[\d:]{8}\sGMT  # Special case for "expires" attr
    |                                  # or
    [""" + _LegalValueChars + r"""]*      # Any word or empty string
    )                                # End of group 'val'
    )?                             # End of optional value group
    \s*                            # Any number of spaces.
    (\s+|;|$)                      # Ending either at space, semicolon, or EOS.
    """, re.ASCII | re.VERBOSE)    # re.ASCII may be removed if safe.

# At long last, here is the cookie class.  Using this class is almost just like
# using a dictionary.  See this module's docstring for example usage.
#
class BaseCookie(dict):
    """A container class for a set of Morsels."""

    def value_decode(self, val):
        """real_value, coded_value = value_decode(STRING)
        Called prior to setting a cookie's value from the network
        representation.  The VALUE is the value read from HTTP
        header.
        Override this function to modify the behavior of cookies.
        """
        return val, val

    def value_encode(self, val):
        """real_value, coded_value = value_encode(VALUE)
        Called prior to setting a cookie's value from the dictionary
        representation.  The VALUE is the value being assigned.
        Override this function to modify the behavior of cookies.
        """
        strval = str(val)
        return strval, strval

    def __init__(self, input=None):
        if input:
            self.load(input)

    def __set(self, key, real_value, coded_value):
        """Private method for setting a cookie's value"""
        M = self.get(key, Morsel())
        M.set(key, real_value, coded_value)
        dict.__setitem__(self, key, M)

    def __setitem__(self, key, value):
        """Dictionary style assignment."""
        if isinstance(value, Morsel):
            # allow assignment of constructed Morsels (e.g. for pickling)
            dict.__setitem__(self, key, value)
        else:
            rval, cval = self.value_encode(value)
            self.__set(key, rval, cval)

    def output(self, attrs=None, header="Set-Cookie:", sep="\015\012"):
        """Return a string suitable for HTTP."""
        result = []
        items = sorted(self.items())
        for key, value in items:
            result.append(value.output(attrs, header))
        return sep.join(result)

    __str__ = output

    def __repr__(self):
        l = []
        items = sorted(self.items())
        for key, value in items:
            l.append('%s=%s' % (key, repr(value.value)))
        return '<%s: %s>' % (self.__class__.__name__, _spacejoin(l))

    def js_output(self, attrs=None):
        """Return a string suitable for JavaScript."""
        result = []
        items = sorted(self.items())
        for key, value in items:
            result.append(value.js_output(attrs))
        return _nulljoin(result)

    def load(self, rawdata):
        """Load cookies from a string (presumably HTTP_COOKIE) or
        from a dictionary.  Loading cookies from a dictionary 'd'
        is equivalent to calling:
            map(Cookie.__setitem__, d.keys(), d.values())
        """
        if isinstance(rawdata, str):
            self.__parse_string(rawdata)
        else:
            # self.update() wouldn't call our custom __setitem__
            for key, value in rawdata.items():
                self[key] = value
        return

    def __parse_string(self, str, patt=_CookiePattern):
        i = 0                 # Our starting point
        n = len(str)          # Length of string
        parsed_items = []     # Parsed (type, key, value) triples
        morsel_seen = False   # A key=value pair was previously encountered

        TYPE_ATTRIBUTE = 1
        TYPE_KEYVALUE = 2

        # We first parse the whole cookie string and reject it if it's
        # syntactically invalid (this helps avoid some classes of injection
        # attacks).
        while 0 <= i < n:
            # Start looking for a cookie
            match = patt.match(str, i)
            if not match:
                # No more cookies
                break

            key, value = match.group("key"), match.group("val")
            i = match.end(0)

            if key[0] == "$":
                if not morsel_seen:
                    # We ignore attributes which pertain to the cookie
                    # mechanism as a whole, such as "$Version".
                    # See RFC 2965. (Does anyone care?)
                    continue
                parsed_items.append((TYPE_ATTRIBUTE, key[1:], value))
            elif key.lower() in Morsel._reserved:
                if not morsel_seen:
                    # Invalid cookie string
                    return
                if value is None:
                    if key.lower() in Morsel._flags:
                        parsed_items.append((TYPE_ATTRIBUTE, key, True))
                    else:
                        # Invalid cookie string
                        return
                else:
                    parsed_items.append((TYPE_ATTRIBUTE, key, _unquote(value)))
            elif value is not None:
                parsed_items.append((TYPE_KEYVALUE, key, self.value_decode(value)))
                morsel_seen = True
            else:
                # Invalid cookie string
                return

        # The cookie string is valid, apply it.
        M = None         # current morsel
        for tp, key, value in parsed_items:
            if tp == TYPE_ATTRIBUTE:
                assert M is not None
                M[key] = value
            else:
                assert tp == TYPE_KEYVALUE
                rval, cval = value
                self.__set(key, rval, cval)
                M = self[key]

class SimpleCookie(BaseCookie):
    """
    SimpleCookie supports strings as cookie values.  When setting
    the value using the dictionary assignment notation, SimpleCookie
    calls the builtin str() to convert the value to a string.  Values
    received from HTTP are kept as strings.
    """
    def value_decode(self, val):
        return _unquote(val), val

    def value_encode(self, val):
        strval = str(val)
        return strval, _quote(strval)

My Alexa Media Player integration is now initializing first time, every time!

7R0D3N commented 1 week ago

Confirming rolling back to 2024.6.2 resolves the issue. It's only 2024.6.3 that has the issue.

xhemp commented 1 week ago

I am on 20024.6.3 and after removing the pickle file and re-adding the integration, I dont see the issue after any number of restarts. Very odd as it seems random for everyone.

carvan commented 1 week ago

I am on 20024.6.3 and after removing the pickle file and re-adding the integration, I dont see the issue after any number of restarts. Very odd as it seems random for everyone.

and I'm still unable to find that file. I looked into the custom_components folder but never found it

xhemp commented 1 week ago

Try inside the .storage folder.

On Fri, 21 Jun 2024, 15:09 carvan, @.***> wrote:

I am on 20024.6.3 and after removing the pickle file and re-adding the integration, I dont see the issue after any number of restarts. Very odd as it seems random for everyone.

and I'm still unable to find that file. I looked into the custom_components folder but never found it

— Reply to this email directly, view it on GitHub https://github.com/alandtse/alexa_media_player/issues/2288#issuecomment-2182829750, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADIEYDAIWF4RQFCWDC4M5ELZIQXZ3AVCNFSM6AAAAABJN7M7RKVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCOBSHAZDSNZVGA . You are receiving this because you are subscribed to this thread.Message ID: @.***>

cslipaco commented 1 week ago

Confirming rolling back to 2024.6.2 resolves the issue. It's only 2024.6.3 that has the issue.

I too can confirm that the only thing that resolved the issue for me after trying everything else was rolling back to 2024.6.2 via the terminal command at the end of this message. I should note, after the roll back, I had to restart HA one more time as Alexa Media Player still threw the same partitioned error.

Please ensure you have a full backup for disaster recovery. I am not responsible if this breaks anything else. With that said, the process was without issue for me.

ha core update --version 2024.6.2

bensoae87 commented 1 week ago

So I've fixed it on my end and here is how.

I first followed the instructions to remove the pickle file suggested by @xhemp. Once that was done, I removed, and then reinstalled the alexa_media_player component from HACS. Upon reinstalling it and a reboot, I changed my settings for scans from 60 seconds to 300 seconds (5 minutes). I then setup the automation mentioed by @danielbrunt57 but set mine for 30 seconds.

I've now rebooted several times, and the issue will be there again until it's reinitialized through the automation, but then is resolved. Make sure for the automation, you target all of the entities that are in your alexa_media_player. Mine looks like the following:

image

alias: Reload Alexa Media Player after HA starts
description: ""
trigger:
  - platform: homeassistant
    event: start
condition: []
action:
  - service: mobile_app_myphone
    data:
      message: Initializing HA/Alexa - This will take about 30 seconds, Please Wait...
      title: Home Assistant - Patched Startup
  - delay:
      hours: 0
      minutes: 0
      seconds: 30
      milliseconds: 0
  - alias: Reload Alexa Media Player integration
    service: homeassistant.reload_config_entry
    data: {}
    enabled: true
    target:
      entity_id:
        - media_player.master_suite_speaker
        - media_player.guest_bedroom_speaker
        - media_player.family_room_speaker
        - media_player.living_room_speaker
        - media_player.garage_speaker
        - media_player.entertainment_room_speaker
        - media_player.playroom_speaker
        - media_player.home_office_speaker
        - media_player.kitchen_family_hub
  - service: notify.mobile_app_myphone
    data:
      title: Home Assistant - Patched Startup
      message: System Ready!
mode: single

I also added a notification on the boot up that sends me a notification on my phone from when it's booted, to when it's ran the re-initialization.

Now I have this:

image

danielbrunt57 commented 1 week ago

Make sure for the automation, you target all of the entities that are in your alexa_media_player

No need to list them all. The homeassistant.reload_config_entry service requires a minimum of one entity_id to be specified and that will reload the config entry for that entity which is the one and only config entry for all of them.

but set mine for 30 seconds

I also had reduced mine from 1 minute to 30 seconds. 10 seconds failed. 20 seconds was hit and miss. But with the new cookies.py script that will be in python 3.13, I don't need a reload as it always works. Downside is that you have to replace cookies.py after each homeassistant update.

Aironside commented 1 week ago

I just installed HA 2024.6.4 and rebooted, but the problem seems to persist.

danielbrunt57 commented 1 week ago

I just installed HA 2024.6.4 and rebooted, but the problem seems to persist.

Yes, problem remains. I installed it on Thursday and had to re-replace cookies.py and re-edit manifest.json

Symbiot78 commented 1 week ago

same here after updating. I've implemented the reload automation mentioned and will wait and see if it gets fixed down the line.

Menz01 commented 1 week ago

i resorted to restoring to an earlier version. i hope it gets fixed soon

JTP335d commented 1 week ago

I noticed this issue 2 days ago when I restarted home assistant after a config change. I came here and found out about this. Today, just now after updating to OS 12.4 and core 2024.6.4, Alexa Media Player started normally. I did 2x restarts just to confirm. I did uncheck "Include devices connected via Echo" when I noticed the issue at first, otherwise I have not changed anything.

danielbrunt57 commented 1 week ago

I deleted the Alexa Media Player integration in HA 2024.6.4, deleted the custom component in HACS and restarted HA. I then deleted the following files in /config/.storage: -rw-r--r-- 1 root root 98 Jun 9 00:39 alexa -rw-r--r-- 1 root root 783 Jun 26 16:13 alexa_auth -rw-r--r-- 1 root root 2577 Jun 26 16:44 alexa_media.daniel@brunt.ca.pickle

I re-installed Alexa Media Player Custom Component in HACS, restarted HA and re-installed the Alexa Media Player integration and, after three HA restarts, Alexa Media Player is initializing just fine now.

It might be worth noting that before starting the above exercise, I reviewed my settings in Edge browser and in Privacy, search and services where I had changed Balanced to Basic some number of weeks ago, I changed it back to Balanced.

So for me, this is no longer an issue.

KennethLavrsen commented 1 week ago

I still have the problem after the upgrade of HA and the OS. I am sad to see this closed. There is obviously an issue with timing since it always fails to load at the restart of HA and always succeeds after a reload.

KennethLavrsen commented 1 week ago

I just did the same exercise that Daniel did. I completely wiped the Alexa Media Player integration, the HACS componens and all the files in .storage. And reinstalled everything

And it still fails at startup of HA but works when you reload the integration. Daniel even if it works for you, can you please reopen the bug report for the rest of us? Or do I need to open a new duplicate report?

Symbiot78 commented 1 week ago

My issue also persists like Kenneth

mac555555 commented 1 week ago

My issue also persists like Kenneth

Mine too.

tbclark3 commented 1 week ago

And mine too. I don't understand why this issue was closed when the underlying problem was not addressed.

danielbrunt57 commented 1 week ago

If you all are still having issues then I am thinking that the change I made in my Microsoft Edge's Privacy, search and services may have resolved my issue. I will re-do my re & re with my previous Edge setting and test restarting a few times...

JTP335d commented 1 week ago

The issue is back(still there) for me also. Not sure why it worked for multiple restarts yesterday but today it failed to load again. To add, I haven’t tried any workarounds, just posting my experience.

Any chance this is more of an Alexa problem? My Alexa app has issues. I also have Sonos(also problematic networking software) speakers within the Alexa ecosystem that show up in the Alexa Media Player integration. These show as unavailable in Alexa and I haven’t been able to successfully remove them there as I don’t really need them exposed to home assistant via Alexa Media Player integration.

danielbrunt57 commented 1 week ago

So, I've restored my Edge Privacy, search and services setting to Basic, removed the integration & HACS component, restarted, deleted alexa* from .storage, verified I have original manifest.json and cookies.py file, reinstalled HACS component, restarted, reinstalled integration and restarted HA three times now and Alexa Media Player is initializing fine.

One difference from before: my Windows 11 has had an automatic update and a reboot in the interim but that I do not see how that should matter.

I'm currently out of ideas as to what is going on...

danielbrunt57 commented 1 week ago

Could someone with the issue try the cookies.py I posted and also the manifest.json edit to see if that fixes their problem???

rweijnen commented 1 week ago

@danielbrunt57 just tested it and it works for me!

danielbrunt57 commented 1 week ago

@danielbrunt57 just tested it and it works for me!

Awesome! I wonder why I no longer need it tough. Very weird...

Which browser (and version) are are you using?

KennethLavrsen commented 1 week ago

The hack of files inside the HA container is a bit risky business. Hacking a custom component I dare. Adding the websocket dependency does not fix it. I am not strong enough in understand docker to attempt hacking code inside HA

I do not understand several things.

What does your experiences with your browser have to do with Home Assistant running in a Linux on a server? Why would the browser used to restart HA make the Python code run differently? I restart my HA from Safari browser on an iPad normally.

And why does the same Python code on the server fail when HA starts up, but works just fine when the integration is reloaded. They key to finding the root cause must and a fix. What is it in HA that is not ready when the integration attempts to start?

Petro31 commented 5 days ago

And why does the same Python code on the server fail when HA starts up, but works just fine when the integration is reloaded. They key to finding the root cause must and a fix. What is it in HA that is not ready when the integration attempts to start?

I think the problem lies with HA's startup changes and blocking calls during integration import.

this is showing up in beta async_forward_entry_setup as something to avoid using and Alexa media player is using that call.

2024-06-28 17:09:02.276 WARNING (MainThread) [homeassistant.helpers.frame] Detected code that calls async_forward_entry_setup for integration alexa_media with title: xxx@xxx.com - amazon.com and entry_id: 83aee4b1bdf4ba886c587005ca6a4a93, during setup without awaiting async_forward_entry_setup, which can cause the setup lock to be released before the setup is done. This will stop working in Home Assistant 2025.1. Please report this issue.