Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Upgrade from ZendFramework 1 #47

Open
22 of 44 tasks
adamfranco opened this issue Dec 2, 2021 · 0 comments · May be fixed by #66
Open
22 of 44 tasks

Upgrade from ZendFramework 1 #47

adamfranco opened this issue Dec 2, 2021 · 0 comments · May be fixed by #66
Assignees
@adamfranco

Comments

@adamfranco
Copy link
Member

adamfranco commented Dec 2, 2021 •
edited
Loading

The CourseCatalog currently uses an out-of-date version of ZendFramework. Either upgrade to a new version of ZF or migrate to Symfony.

  • All controller methods ported in...
    • Admin
    • Archive
    • Bookmarks
    • Catalogs
    • Courses
    • Export
    • Json
    • Offerings
    • Resources
    • Schedules
    • Terms
    • Topics
    • Utils
  • Set front page route
  • Migrate application cache to use the Symfony Cache service.
  • New theme wrapper applied
  • Menu system added
  • Port CLI tools for migrating from Banner.
    • Migrate CatalogSync to services
    • Add strict typing to interfaces
    • Port mail sending to Symfony mailer
    • Use console IO for output
    • Ensure that OCI update actually happens in a single transaction or at least a transaction per table to allow reads to be successful during update (currently viewing the tables via phpmyadmin exposes the rows as they are inserted). It turns out that the phpmyadmin row estimate is not transaction aware, but SELECT COUNT(*) FROM <table> doesn't change while INSERT statements are happening
    • Pass $allowedBlkCodes as an array from the environment.
  • Port CLI tools for exporting archives
  • Update Controller actions to cast parameters to osid_id_Id objects
  • Update constructors to short member assignment style
  • Remove any commented out code.
  • Include remaining libraries via composer rather than Git submodules:
    • fsmparser
    • jsdifflib
    • lazysessions (probably not needed with symfony...)
    • osid-phpkit
  • Ensure final code meets coding style
  • Ensure final code has no/minimal deprecations for PHP8.3 compatibility.
  • Add favicon
  • Add phpunit tests for application page load success

Follow-up:

  • Ensure that Controller actions use consistent ordering and inclusion of catalog and term parameters.
  • Ensure that Controller actions use consistent naming for arguments
  • migrate usage of setCacheControlHeaders().
  • Update direct usage of header() for errors to use a Symfony Response
  • Update SAML login to avoid creating a session prior to successful login.
  • Ensure that responses to /courses/instructorxml/{instructorId}/{catalogId} with not-found instructors are cacheable.
@adamfranco adamfranco self-assigned this Dec 2, 2021
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Add symfony framework structure and remove phpcas.
34206ce 
Generated with
    composer create-project symfony/skeleton:"6.4.*" catalog-symfony
then manually merged into the application directory.
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Move the Catalogs controller into the Symfony structure.
80958b0
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Remove +SymLinksIfOwnerMatch directive that is breaking on tobog…
c9c5d4c 
…gan.
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Wire up a new osid.runtime service to access the OSID API.
1021e45
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Use PSR-0 autoloading for osid-phpkit.
c3ef1d0
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Use PSR-0 autoloading for existing code in application/library/
7dc2c46 
For now we can skip any reorganization, addition of namespaces, and other
refactoring of the main data model while getting controllers and views
ported over to Symfony.
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Add symfony/twig-bundle for rendering suppport.
397f6ec
adamfranco added a commit that referenced this issue Sep 26, 2024
@adamfranco
#47: Build out catalog listing template and action.
2f817fd
@adamfranco adamfranco linked a pull request Sep 26, 2024 that will close this issue
Draft
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Add PHPUnit as a dev dependency.
3a90230
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Change the database to mariadb to mirror prod.
3357430
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Convert id-subcomponent separator from '/' to '.'.
8336afc 
The use of '/' as a separator in subcomponents turned out to be a bad idea
because these slashes need to be escaped as %2F, but these escaped slashes
can interfere with some webserver configuration.

For example Apache redirects require the NE "No Escape" option to preserve
%2F slashes without double-escaping:

    # Redirect all traffic to https
    #
    # We're using mod_rewrite here rather than mod_alias's `Redirect`
    # because mod_alias doesn't allow the "NE" == "noescape" parameter
    # that allows URLs includinging encoded slashes (%2F) to be returned
    # without double-escaping.
    RewriteRule .* https://<%= node["app_domain"] %>$0 [L,R=301,NE]

Similarly, Symfony refuses to allow slashes in parameters passed as tokens
in routes.

To address this problematic choice, use '.' as a separator of
sub-components in identifiers. Periods don't require special escaping in
URLs or database queries, though they do in regular expressions.
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Use pre-existing 'test' database available in local dev environm…
2fc1b25 
…ent.
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Fix Deprecated array access of boolean value error.
ec5c0fa
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Update id-subcomponent separators missed in 8336afc
ed320b8
adamfranco added a commit that referenced this issue Sep 27, 2024
@adamfranco
#47: Get the Catalog list working with a redirect to offering search.
1980c91 
Other actions are still a work in progress.
adamfranco added a commit that referenced this issue Oct 1, 2024
@adamfranco
#47: Port the offering view action.
7fdc42e
adamfranco added a commit that referenced this issue Oct 1, 2024
@adamfranco
#47: Add twig extensions to allow building of URLs from osid_Id objects.
024361b
adamfranco added a commit that referenced this issue Oct 1, 2024
@adamfranco
#47: Ensure that the FSMParser and Harmoni Primitives classes are ava…
77e1356 
…ilable
adamfranco added a commit that referenced this issue Oct 3, 2024
@adamfranco
#47: Use subdirectories for template files to aid organization.
df1de2c
adamfranco added a commit that referenced this issue Oct 3, 2024
@adamfranco
#47: Add single-section XML view.
4cb5999
adamfranco added a commit that referenced this issue Oct 3, 2024
@adamfranco
#47: Reorganize offering XML template code into a self-contained part…
f2c7e69 
…ial.
adamfranco added a commit that referenced this issue Oct 3, 2024
@adamfranco
#47: Reorganize internal methods to the end of the class.
2885b60
adamfranco added a commit that referenced this issue Oct 8, 2024
@adamfranco
#47: Add single course view.
6a202bd
adamfranco added a commit that referenced this issue Oct 9, 2024
@adamfranco
#47: Add single-course XML view.
d1c7415
adamfranco added a commit that referenced this issue Oct 9, 2024
@adamfranco
#47: Add course list action.
c4da8cf
adamfranco added a commit that referenced this issue Oct 9, 2024
@adamfranco
#47: Migrate courses by id XML action.
bfc3eb2
adamfranco added a commit that referenced this issue Oct 10, 2024
@adamfranco
#47: Update courses by id XML action to match values currently in out…
7d03296 
…put.
adamfranco added a commit that referenced this issue Oct 10, 2024
@adamfranco
#47: Port courses by topic xml action.
f987c56
adamfranco added a commit that referenced this issue Nov 25, 2024
@adamfranco
#47: Pass $allowedBlckCodes to the syncer.
b29b40e
adamfranco added a commit that referenced this issue Nov 25, 2024
@adamfranco
#47: Let SYNC_ALLOWED_BLOCK_CODES to be configured in .env.
5ec4543 
This uses an encoded JSON array to pass from shell, to YAML.
adamfranco added a commit that referenced this issue Nov 25, 2024
@adamfranco
#47: Can now configure different sync strategies.
c0237f3
adamfranco added a commit that referenced this issue Dec 2, 2024
@adamfranco
#47: Add a proxied hostname for easy access to phpmyadmin in dev.
ba107c4
adamfranco added a commit that referenced this issue Dec 2, 2024
@adamfranco
#47: Fix variable name missed previously.
167376b
adamfranco added a commit that referenced this issue Dec 2, 2024
@adamfranco
#47: Copy over admin controller and index action.
1293fb6
adamfranco added a commit that referenced this issue Dec 2, 2024
@adamfranco
#47: Assign user roles via SAML claims.
550ad5e 
In the old version of the catalog we had a list of adminstrator ids in a
configuration file to provide access to management features. Instead,
shift that assignment off to Azure AD to make it easier to review and
modify via the AzureAD admin tools.
adamfranco added a commit that referenced this issue Dec 2, 2024
@adamfranco
#47: Port the term visibility management actions.
378d297
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Add tests for term visibility admin.
f2fff05
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Fix tests to work with role change from 550ad5e
527b9b6
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Pull the term visibility administration code into its own contro…
3988358 
…ller.
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Move Antirequisite and Export configs to their own controllers.
59cf681
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Port description markup testing tool.
9f7c449
adamfranco added a commit that referenced this issue Dec 3, 2024
@adamfranco
#47: Port admin antirequisites screen and add tests.
c2bebda
adamfranco added a commit that referenced this issue Dec 4, 2024
@adamfranco
#47: Port the masquerade action.
8f3d42f
adamfranco added a commit that referenced this issue Dec 17, 2024
@adamfranco
#47: Initial stage of porting the Export system. Config edit screen l…
a0afb05 
…oads.

Much more to do still.
adamfranco added a commit that referenced this issue Dec 19, 2024
@adamfranco
#47: Port export configuration diff view.
775bf21
adamfranco added a commit that referenced this issue Dec 19, 2024
@adamfranco
#47: Port the revision JSON view action.
2d33158
adamfranco added a commit that referenced this issue Dec 19, 2024
@adamfranco
#47: Port export config revert actions.
3bf5472
adamfranco added a commit that referenced this issue Dec 19, 2024
@adamfranco
#47: Fix reset button in export config UI.
36cc918
adamfranco added a commit that referenced this issue Dec 19, 2024
@adamfranco
#47: Run Prittier on all Javascripts to clean up code formatting.
a5766fb
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Creating new export configurations now works.
c329e19
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Can now delete export configurations.
a1aeaac
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Fix error when re-selecting the prompt.
6a1f008
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Rename template into export directory for consistency.
aec8771
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Split export config management & scheduling into separate contro…
0656722 
…llers
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Reorganize and rename export configuration routes for consistency.
94d3942
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Add CSRF keys to export form submission actions.
620fa40
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Fix deprecation notice for query().
e495c61
adamfranco added a commit that referenced this issue Dec 20, 2024
@adamfranco
#47: Add unit tests for Export configuration actions.
c169d84
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@adamfranco adamfranco

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Migrate to ZendFramework to Symfony middlebury/coursecatalog
1 participant
@adamfranco