From 00b143297482143b85f819afa3b44d05d2e5da50 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Thu, 23 Jul 2015 11:07:20 +1000 Subject: [PATCH 1/3] Allow support for multiple meteor apps in a single django-ddp enabled project by reading METEOR_STAR_JSON as part of view init instead of app ready. --- dddp/server/apps.py | 171 ------------------------------------------ dddp/server/views.py | 175 +++++++++++++++++++++++++++++++++++++++++-- 2 files changed, 168 insertions(+), 178 deletions(-) diff --git a/dddp/server/apps.py b/dddp/server/apps.py index 3065be9..4a742e9 100644 --- a/dddp/server/apps.py +++ b/dddp/server/apps.py @@ -1,37 +1,9 @@ """Django DDP Server app config.""" from __future__ import print_function, absolute_import, unicode_literals -import io import mimetypes -import os.path from django.apps import AppConfig -from django.conf import settings -from django.core.exceptions import ImproperlyConfigured -from ejson import dumps, loads -import pybars - - -STAR_JSON_SETTING_NAME = 'METEOR_STAR_JSON' - - -def read(path, default=None, encoding='utf8'): - """Read encoded contents from specified path or return default.""" - if not path: - return default - try: - with io.open(path, mode='r', encoding=encoding) as contents: - return contents.read() - except IOError: - if default is not None: - return default - raise - - -def read_json(path): - """Read JSON encoded contents from specified path.""" - with open(path, mode='r') as json_file: - return loads(json_file.read()) class ServerConfig(AppConfig): @@ -41,149 +13,6 @@ class ServerConfig(AppConfig): name = 'dddp.server' verbose_name = 'Django DDP Meteor Web Server' - manifest = None - program_json = None - program_json_path = None - runtime_config = None - - star_json = None # top level layout - server_json = None # web server layout - web_browser_json = None # web.browser (client) layout - - url_map = None - internal_map = None - server_load_map = None - template_path = None # web server HTML template path - client_map = None # web.browser (client) URL to path map - html = '\nDDP App' - def ready(self): """Configure Django DDP server app.""" mimetypes.init() # read and process /etc/mime.types - self.url_map = {} - - try: - json_path = getattr(settings, STAR_JSON_SETTING_NAME) - except AttributeError: - raise ImproperlyConfigured( - '%s setting required by dddp.server.view.' % ( - STAR_JSON_SETTING_NAME, - ), - ) - - self.star_json = read_json(json_path) - star_format = self.star_json['format'] - if star_format != 'site-archive-pre1': - raise ValueError( - 'Unknown Meteor star format: %r' % star_format, - ) - programs = { - program['name']: program - for program in self.star_json['programs'] - } - - server_json_path = os.path.join( - os.path.dirname(json_path), - os.path.dirname(programs['server']['path']), - 'program.json', - ) - self.server_json = read_json(server_json_path) - server_format = self.server_json['format'] - if server_format != 'javascript-image-pre1': - raise ValueError( - 'Unknown Meteor server format: %r' % server_format, - ) - self.server_load_map = {} - for item in self.server_json['load']: - item['path_full'] = os.path.join( - os.path.dirname(server_json_path), - item['path'], - ) - self.server_load_map[item['path']] = item - self.url_map[item['path']] = ( - item['path_full'], 'text/javascript' - ) - try: - item['source_map_full'] = os.path.join( - os.path.dirname(server_json_path), - item['sourceMap'], - ) - self.url_map[item['sourceMap']] = ( - item['source_map_full'], 'text/plain' - ) - except KeyError: - pass - self.template_path = os.path.join( - os.path.dirname(server_json_path), - self.server_load_map[ - 'packages/boilerplate-generator.js' - ][ - 'assets' - ][ - 'boilerplate_web.browser.html' - ], - ) - - web_browser_json_path = os.path.join( - os.path.dirname(json_path), - programs['web.browser']['path'], - ) - self.web_browser_json = read_json(web_browser_json_path) - web_browser_format = self.web_browser_json['format'] - if web_browser_format != 'web-program-pre1': - raise ValueError( - 'Unknown Meteor web.browser format: %r' % ( - web_browser_format, - ), - ) - self.client_map = {} - self.internal_map = {} - for item in self.web_browser_json['manifest']: - item['path_full'] = os.path.join( - os.path.dirname(web_browser_json_path), - item['path'], - ) - if item['where'] == 'client': - if '?' in item['url']: - item['url'] = item['url'].split('?', 1)[0] - self.client_map[item['url']] = item - self.url_map[item['url']] = ( - item['path_full'], - mimetypes.guess_type( - item['path_full'], - )[0] or 'application/octet-stream', - ) - elif item['where'] == 'internal': - self.internal_map[item['type']] = item - - config = { - 'css': [ - {'url': item['path']} - for item in self.web_browser_json['manifest'] - if item['type'] == 'css' and item['where'] == 'client' - ], - 'js': [ - {'url': item['path']} - for item in self.web_browser_json['manifest'] - if item['type'] == 'js' and item['where'] == 'client' - ], - 'meteorRuntimeConfig': '"%s"' % ( - dumps(self.runtime_config) - ), - 'rootUrlPathPrefix': '/app', - 'bundledJsCssPrefix': '/app/', - 'inlineScriptsAllowed': False, - 'inline': None, - 'head': read( - self.internal_map.get('head', {}).get('path_full', None), - default=u'', - ), - 'body': read( - self.internal_map.get('body', {}).get('path_full', None), - default=u'', - ), - } - tmpl_raw = read(self.template_path, encoding='utf8') - compiler = pybars.Compiler() - tmpl = compiler.compile(tmpl_raw) - self.html = '\n%s' % tmpl(config) diff --git a/dddp/server/views.py b/dddp/server/views.py index 59e4575..9084fc5 100644 --- a/dddp/server/views.py +++ b/dddp/server/views.py @@ -1,13 +1,35 @@ """Django DDP Server views.""" from __future__ import print_function, absolute_import, unicode_literals -from ejson import dumps -from django.apps import apps + +import io +import mimetypes +import os.path + +from ejson import dumps, loads from django.conf import settings from django.http import HttpResponse from django.views.generic import View +import pybars -STAR_JSON_SETTING_NAME = 'METEOR_STAR_JSON' + +def read(path, default=None, encoding='utf8'): + """Read encoded contents from specified path or return default.""" + if not path: + return default + try: + with io.open(path, mode='r', encoding=encoding) as contents: + return contents.read() + except IOError: + if default is not None: + return default + raise + + +def read_json(path): + """Read JSON encoded contents from specified path.""" + with open(path, mode='r') as json_file: + return loads(json_file.read()) class MeteorView(View): @@ -16,13 +38,152 @@ class MeteorView(View): http_method_names = ['get', 'head'] - app = None + json_path = None runtime_config = None + manifest = None + program_json = None + program_json_path = None + runtime_config = None + + star_json = None # top level layout + + url_map = None + internal_map = None + server_load_map = None + template_path = None # web server HTML template path + client_map = None # web.browser (client) URL to path map + html = '\nDDP App' + + root_url_path_prefix = '' + bundled_js_css_prefix = '/' + def __init__(self, **kwargs): """Initialisation for Django DDP server view.""" + # super(...).__init__ assigns kwargs to instance. super(MeteorView, self).__init__(**kwargs) - self.app = apps.get_app_config('server') + + self.url_map = {} + + # process `star_json` + self.star_json = read_json(self.json_path) + star_format = self.star_json['format'] + if star_format != 'site-archive-pre1': + raise ValueError( + 'Unknown Meteor star format: %r' % star_format, + ) + programs = { + program['name']: program + for program in self.star_json['programs'] + } + + # process `bundle/programs/server/program.json` from build dir + server_json_path = os.path.join( + os.path.dirname(self.json_path), + os.path.dirname(programs['server']['path']), + 'program.json', + ) + server_json = read_json(server_json_path) + server_format = server_json['format'] + if server_format != 'javascript-image-pre1': + raise ValueError( + 'Unknown Meteor server format: %r' % server_format, + ) + self.server_load_map = {} + for item in server_json['load']: + item['path_full'] = os.path.join( + os.path.dirname(server_json_path), + item['path'], + ) + self.server_load_map[item['path']] = item + self.url_map[item['path']] = ( + item['path_full'], 'text/javascript' + ) + try: + item['source_map_full'] = os.path.join( + os.path.dirname(server_json_path), + item['sourceMap'], + ) + self.url_map[item['sourceMap']] = ( + item['source_map_full'], 'text/plain' + ) + except KeyError: + pass + self.template_path = os.path.join( + os.path.dirname(server_json_path), + self.server_load_map[ + 'packages/boilerplate-generator.js' + ][ + 'assets' + ][ + 'boilerplate_web.browser.html' + ], + ) + + # process `bundle/programs/web.browser/program.json` from build dir + web_browser_json_path = os.path.join( + os.path.dirname(self.json_path), + programs['web.browser']['path'], + ) + web_browser_json = read_json(web_browser_json_path) + web_browser_format = web_browser_json['format'] + if web_browser_format != 'web-program-pre1': + raise ValueError( + 'Unknown Meteor web.browser format: %r' % ( + web_browser_format, + ), + ) + self.client_map = {} + self.internal_map = {} + for item in web_browser_json['manifest']: + item['path_full'] = os.path.join( + os.path.dirname(web_browser_json_path), + item['path'], + ) + if item['where'] == 'client': + if '?' in item['url']: + item['url'] = item['url'].split('?', 1)[0] + self.client_map[item['url']] = item + self.url_map[item['url']] = ( + item['path_full'], + mimetypes.guess_type( + item['path_full'], + )[0] or 'application/octet-stream', + ) + elif item['where'] == 'internal': + self.internal_map[item['type']] = item + + config = { + 'css': [ + {'url': item['path']} + for item in web_browser_json['manifest'] + if item['type'] == 'css' and item['where'] == 'client' + ], + 'js': [ + {'url': item['path']} + for item in web_browser_json['manifest'] + if item['type'] == 'js' and item['where'] == 'client' + ], + 'meteorRuntimeConfig': '"%s"' % ( + dumps(self.runtime_config) + ), + 'rootUrlPathPrefix': self.root_url_path_prefix, + 'bundledJsCssPrefix': self.bundled_js_css_prefix, + 'inlineScriptsAllowed': False, + 'inline': None, + 'head': read( + self.internal_map.get('head', {}).get('path_full', None), + default=u'', + ), + 'body': read( + self.internal_map.get('body', {}).get('path_full', None), + default=u'', + ), + } + tmpl_raw = read(self.template_path, encoding='utf8') + compiler = pybars.Compiler() + tmpl = compiler.compile(tmpl_raw) + self.html = '\n%s' % tmpl(config) def get(self, request, path): """Return HTML (or other related content) for Meteor.""" @@ -46,7 +207,7 @@ class MeteorView(View): content_type='text/javascript', ) try: - file_path, content_type = self.app.url_map[path] + file_path, content_type = self.url_map[path] with open(file_path, 'r') as content: return HttpResponse( content.read(), @@ -54,5 +215,5 @@ class MeteorView(View): ) except KeyError: print(path) - return HttpResponse(self.app.html) + return HttpResponse(self.html) # raise Http404 From e5784ac4caee6447258cb801ef425bf2126c0c13 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Tue, 11 Aug 2015 14:55:43 +1000 Subject: [PATCH 2/3] Drop dddp.server app, dddp.server.views moved to dddp.views --- dddp/server/__init__.py | 1 - dddp/server/apps.py | 18 ------------------ dddp/{server => }/views.py | 3 +++ 3 files changed, 3 insertions(+), 19 deletions(-) delete mode 100644 dddp/server/__init__.py delete mode 100644 dddp/server/apps.py rename dddp/{server => }/views.py (99%) diff --git a/dddp/server/__init__.py b/dddp/server/__init__.py deleted file mode 100644 index cea26b4..0000000 --- a/dddp/server/__init__.py +++ /dev/null @@ -1 +0,0 @@ -default_app_config = 'dddp.server.apps.ServerConfig' diff --git a/dddp/server/apps.py b/dddp/server/apps.py deleted file mode 100644 index 4a742e9..0000000 --- a/dddp/server/apps.py +++ /dev/null @@ -1,18 +0,0 @@ -"""Django DDP Server app config.""" -from __future__ import print_function, absolute_import, unicode_literals - -import mimetypes - -from django.apps import AppConfig - - -class ServerConfig(AppConfig): - - """Django config for dddp.server app.""" - - name = 'dddp.server' - verbose_name = 'Django DDP Meteor Web Server' - - def ready(self): - """Configure Django DDP server app.""" - mimetypes.init() # read and process /etc/mime.types diff --git a/dddp/server/views.py b/dddp/views.py similarity index 99% rename from dddp/server/views.py rename to dddp/views.py index 9084fc5..76ebfac 100644 --- a/dddp/server/views.py +++ b/dddp/views.py @@ -63,6 +63,9 @@ class MeteorView(View): # super(...).__init__ assigns kwargs to instance. super(MeteorView, self).__init__(**kwargs) + # read and process /etc/mime.types + mimetypes.init() + self.url_map = {} # process `star_json` From 66ed01a393db11e16acac22b22c94b96777a2625 Mon Sep 17 00:00:00 2001 From: Tyson Clugg Date: Tue, 11 Aug 2015 14:56:39 +1000 Subject: [PATCH 3/3] Update README.rst, CHANGES.rst and bumped version number. --- CHANGES.rst | 6 +++++ README.rst | 63 ++++++++++++++++++++++++++++++++++++++++++++++------- setup.py | 2 +- 3 files changed, 62 insertions(+), 9 deletions(-) diff --git a/CHANGES.rst b/CHANGES.rst index 5a8edb4..2eae416 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -1,6 +1,12 @@ Change Log ========== +0.12.0 +------ +* Get path to `star.json` from view config (defined in your urls.py) + instead of from settings. +* Dropped `dddp.server.views`, use `dddp.views` instead. + 0.11.0 ------ * Support more than 8KB of change data by splitting large payloads into diff --git a/README.rst b/README.rst index afd6ece..367cc6e 100644 --- a/README.rst +++ b/README.rst @@ -103,6 +103,19 @@ Add ddp.py to your Django application: [Book, Author, AllBooks, BooksByAuthorEmail] ) +Start the Django DDP service: + +.. code:: sh + + DJANGO_SETTINGS_MODULE=myproject.settings dddp + + +Using django-ddp as a secondary DDP connection (RAPID DEVELOPMENT) +------------------------------------------------------------------ + +Running in this manner allows rapid development through use of the hot +code push features provided by Meteor. + Connect your Meteor application to the Django DDP service: .. code:: javascript @@ -118,19 +131,53 @@ Connect your Meteor application to the Django DDP service: Django.subscribe('BooksByAuthorEmail', 'janet@evanovich.com'); } -Start the Django DDP service: - -.. code:: sh - - DJANGO_SETTINGS_MODULE=myproject.settings dddp - -In a separate terminal, start Meteor (from within your meteor -application directory): +Start Meteor (from within your meteor application directory): .. code:: sh meteor +Using django-ddp as the primary DDP connection (RECOMMENDED) +------------------------------------------------------------ + +If you'd prefer to not have two DDP connections (one to Meteor and one +to django-ddp) you can set the `DDP_DEFAULT_CONNECTION_URL` environment +variable to use the specified URL as the primary DDP connection in +Meteor. When doing this, you won't need to use `DDP.connect(...)` or +specify `{connection: Django}` on your collections. Running with +django-ddp as the primary connection is recommended, and indeed required +if you wish to use `dddp.accounts` to provide authentication using +`django.contrib.auth` to your meteor app. + +.. code:: sh + + DDP_DEFAULT_CONNECTION_URL=http://localhost:8000/ meteor + + +Serving your Meteor applications from django-ddp +------------------------------------------------ + +First, you will need to build your meteor app into a directory (examples +below assume target directory named `myapp`): + +.. code:: sh + + meteor build ../myapp + +Then, add a MeteorView to your urls.py: + +.. code:: python + + from dddp.views import MeteorView + + urlpatterns = patterns( + url('^(?P/.*)$', MeteorView.as_view( + json_path=os.path.join( + settings.PROJ_ROOT, 'myapp', 'bundle', 'star.json', + ), + ), + ) + Adding API endpoints (server method definitions) ------------------------------------------------ diff --git a/setup.py b/setup.py index 50e90a1..c84f740 100644 --- a/setup.py +++ b/setup.py @@ -5,7 +5,7 @@ from setuptools import setup, find_packages setup( name='django-ddp', - version='0.11.0', + version='0.12.0', description=__doc__, long_description=open('README.rst').read(), author='Tyson Clugg',