Merge pull request #16 from smcclennon/beta

v1.0.0 - Docker Support & Stability Improvements

Author: smcclennon

app/ACRAPI.py

@@ -13,23 +13,23 @@
         "access_secret": env['acr']['clear']['access_secret'],
         "recognize_type": ACRCloudRecognizeType.ACR_OPT_REC_AUDIO,
         "debug":  False,
-        "timeout": env['acr']['clear']['timeout']
+        "timeout": int(env['acr']['clear']['timeout'])
     },
     "noisy": {
         "host": env['acr']['noisy']['host'],
         "access_key": env['acr']['noisy']['access_key'],
         "access_secret": env['acr']['noisy']['access_secret'],
         "recognize_type": ACRCloudRecognizeType.ACR_OPT_REC_AUDIO,
         "debug": False,
-        "timeout": env['acr']['noisy']['timeout']
+        "timeout": int(env['acr']['noisy']['timeout'])
     },
     "hum": {
         "host": env['acr']['hum']['host'],
         "access_key": env['acr']['hum']['access_key'],
         "access_secret": env['acr']['hum']['access_secret'],
         "recognize_type": ACRCloudRecognizeType.ACR_OPT_REC_BOTH,
         "debug": False,
-        "timeout": env['acr']['hum']['timeout']
+        "timeout": int(env['acr']['hum']['timeout'])
     }
 }
 logger.info('Loaded: ACR Config')
@@ -49,15 +49,18 @@ def noisy(filePath):
         '''This module can recognize ACRCloud by most of audio/video file.
             Audio: mp3, wav, m4a, flac, aac, amr, ape, ogg ...
             Video: mp4, mkv, wmv, flv, ts, avi ...'''
-        re = ACRCloudRecognizer(config['noisy'])
+        re_config = config['noisy']
+        re = ACRCloudRecognizer(re_config)
 
         #recognize by file path, and skip 0 seconds from from the beginning of sys.argv[1].
         #re.recognize_by_file(filePath, 0, 10)
-        logger.info('ACR: Processing request...')
+        logger.info('ACR: Processing Noisy request...')
+        logger.debug(re_config)
         buf = open(filePath, 'rb').read()
         #recognize by file_audio_buffer that read from file path, and skip 0 seconds from from the beginning of sys.argv[1].
         data = re.recognize_by_filebuffer(buf, 0, 60)
         data = json.loads(data)
+        logger.debug(data)
         logger.info('ACR: Processing complete!')
         return data
 
@@ -69,14 +72,17 @@ def hum(filePath):
         '''This module can recognize ACRCloud by most of audio/video file.
             Audio: mp3, wav, m4a, flac, aac, amr, ape, ogg ...
             Video: mp4, mkv, wmv, flv, ts, avi ...'''
-        re = ACRCloudRecognizer(config['hum'])
+        re_config = config['hum']
+        re = ACRCloudRecognizer(re_config)
 
         #recognize by file path, and skip 0 seconds from from the beginning of sys.argv[1].
         #re.recognize_by_file(filePath, 0, 10)
-        logger.info('ACR: Processing request...')
+        logger.info('ACR: Processing Hum request...')
+        logger.debug(re_config)
         buf = open(filePath, 'rb').read()
         #recognize by file_audio_buffer that read from file path, and skip 0 seconds from from the beginning of sys.argv[1].
         data = re.recognize_by_filebuffer(buf, 0, 10)
         data = json.loads(data)
+        logger.debug(data)
         logger.info('ACR: Processing complete!')
         return data

app/SongID.py

@@ -10,8 +10,6 @@
 import urllib.request  # Check for internet connectivity
 
 
-os.system(f'title _ _  ---====  SongID {ver}  ====---  _ _')  # Set the windows console window title
-
 while True:
     try:
         ACR_PING_CODE = urllib.request.urlopen("https://identify-eu-west-1.acrcloud.com").getcode()
@@ -128,10 +126,7 @@ def sendMsg(update, context):
 # (When the user adds a telegram bot, they are forced to send '/start')
 def startCMD(update, context):
     logusr(update)
-    userID=str(update.effective_chat.id)
-    username=str(update.effective_chat.username)
-    if userID not in userdata:
-        SIDProcessor.addUserData(update, '0', '0')
+    SIDProcessor.addUserIfNotExists(update)
     botsend(update, context, f'''<b>{botName}</b> is a Telegram bot that can identify music, similar to Shazam
 
 Key Features:
@@ -195,6 +190,7 @@ def invalidFiletype(update, context):
 # Send the user the data we have saved on them when they send '/mydata'
 def mydataCMD(update, context):
     logusr(update)
+    SIDProcessor.addUserIfNotExists(update)
     data=SIDProcessor.getUserData(update)
     user = update.effective_chat.id
     username = data["username"]
@@ -224,15 +220,18 @@ def maintenanceINFO(update, context):
 
 
 def noisyProcess(update, context):
+    SIDProcessor.addUserIfNotExists(update)
     SIDProcessor.fileProcess(update, context, 'noisy')
 
 
 # Currently not in use
 def clearProcess(update, context):
+    SIDProcessor.addUserIfNotExists(update)
     SIDProcessor.fileProcess(update, context, 'clear')
 
 
 def humProcess(update, context):
+    SIDProcessor.addUserIfNotExists(update)
     SIDProcessor.fileProcess(update, context, 'hum')
 
 maintenance = 0

app/SongIDCore.py

@@ -1,29 +1,20 @@
-import telegram, json, time, os
+import telegram, json, time, os, logging, sentry_sdk
 from telegram.ext import Updater, MessageHandler, Filters, CommandHandler, MessageQueue
-import sentry_sdk
 
 
-ver='1.0.0-beta3'
+ver='1.0.0'
 botName=f'SongID'
 botVer=f'{botName} {ver}'
 botAt=f'@SongIDBot'
 botUsername='SongIDbot'
 downloadDIR='downloads'
 
 
-# Initialise the logger and format it's output
-import logging
-logging.basicConfig(
-    level=logging.INFO,
-    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
-    datefmt='%d-%m-%Y %H:%M:%S',
-)
-logger = logging.getLogger(__name__)
-
-
 #  Load environment variables
 env = {
+    'environment': os.getenv('SONGID_ENVIRONMENT', 'undefined'),
     'sentry_dsn': os.getenv('SONGID_SENTRY_DSN'),
+    'log_level': os.getenv('SONGID_LOG_LEVEL'),
     'telegram': {
         'bot_token': os.getenv('SONGID_TELEGRAM_BOT_TOKEN'),
         'dev_id': os.getenv('SONGID_TELEGRAM_DEV_ID'),
@@ -57,16 +48,41 @@
 token = env['telegram']['bot_token']
 devid = env['telegram']['dev_id']
 devusername = env['telegram']['dev_username']
+loglevel = env['log_level'].upper()
 sentry_dsn = env['sentry_dsn']
 
-sentry_sdk.init(
-dsn=sentry_dsn,
-release=ver,
-sample_rate=1.0,
-traces_sample_rate=1.0,
-attach_stacktrace=True,
-with_locals=True
+
+# Initialise the logger and format it's output
+if loglevel == 'DEBUG':
+    loglevel = logging.DEBUG
+elif loglevel == 'INFO':
+    loglevel = logging.INFO
+elif loglevel == 'WARNING':
+    loglevel = logging.WARNING
+elif loglevel == 'ERROR':
+    loglevel = logging.ERROR
+else:
+    loglevel = logging.INFO
+    print('Invalid log level specified, defaulting to INFO')
+
+print(f'Initializing logger with log level {loglevel}')
+logging.basicConfig(
+    level=loglevel,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    datefmt='%Y-%m-%d %H:%M:%S',
 )
+logger = logging.getLogger(__name__)
+
+if env['environment'] != 'development':
+    sentry_sdk.init(
+    dsn=sentry_dsn,
+    release=ver,
+    environment=env['environment'],
+    sample_rate=1.0,
+    traces_sample_rate=1.0,
+    attach_stacktrace=True,
+    with_locals=True
+    )
 
 
 # Load data/userdata.json into the variable 'userdata'

app/SongIDProcessor.py

@@ -210,6 +210,13 @@ def dataProcess(update, context, data):
 
 class SIDProcessor():
 
+    def addUserIfNotExists(update):
+        userID=str(update.effective_chat.id)
+        username=str(update.effective_chat.username)
+        if userID not in userdata:
+            logger.info(f'User does not exist: {update.effective_user.id}')
+            SIDProcessor.addUserData(update, '0', '0')
+
     # Add user data to the 'userdata' variable and save it to disk
     def addUserData(update, apiCalls, lastCall):
         userdata[f'{update.effective_user.id}'] = {'username': f'{update.effective_chat.username}', 'name': f'{update.effective_user.first_name} {update.effective_user.last_name}', 'api_calls': f'{apiCalls}', 'last_call': f'{lastCall}'}

docker-compose.yml

@@ -8,7 +8,9 @@ services:
       - songid-data:/app/data  # Use a named volume for the data directory
     environment:
       - PYTHONUNBUFFERED=1  # See logs in real-time
-      - SONGID_SENTRY_DSN=${SONGID_SENTRY_DSN}  # Error logging (https://[email protected]/0)
+      - SONGID_LOG_LEVEL=${SONGID_LOG_LEVEL}  # DEBUG, INFO, WARNING, ERROR
+      - SONGID_ENVIRONMENT=${SONGID_ENVIRONMENT}  # production, staging, development
+      - SONGID_SENTRY_DSN=${SONGID_SENTRY_DSN}  # Remote error logging (https://[email protected]/0)
       - SONGID_TELEGRAM_BOT_TOKEN=${SONGID_TELEGRAM_BOT_TOKEN}
       - SONGID_TELEGRAM_DEV_ID=${SONGID_TELEGRAM_DEV_ID}  # Developer ID (000000000)
       - SONGID_TELEGRAM_DEV_USERNAME=${SONGID_TELEGRAM_DEV_USERNAME}  # Developer username (@username)

requirements.txt

@@ -1,3 +1,3 @@
-git+https://github.com/acrcloud/acrcloud_sdk_python.git@8354634bb24e737d67918dfc507cfc4b1d0fbc1e
+pyacrcloud==1.0.2
 python-telegram-bot==13.7
 sentry-sdk==1.5.4