[Spike] Generate PDF Certificates #625

steventux · 2024-04-10T12:58:59Z

Context

Users download their PDF certificate from AYTQ.
The certificate is currently generated in the API which, given this is a frontend concern, isn’t ideal architecturally and adds complexity to the API and infrastructure.

Changes proposed in this pull request

This PR is a proof of concept for Certificate PDF generation. It covers the basic use case of generating a QTS Certificate.

TODO:

View templates for all certificate types
Replicate current certificate file names
Excluding non-certificate requests from PDF generation
Port any conditional rendering logic from DQT-API
Secure HTML format of certificates
PDF assets - fonts and images
System specs

Guidance to review

Link to Trello card

https://trello.com/c/gyZSM5bs/1980-spike-generate-pdf-certificates-in-aytq

See https://trello.com/c/xdaplb8l/2022-implement-aytq-certificate-pdf-generation for implementation story

Checklist

Attach to Trello card
Rebased main
Cleaned commit history
Tested by running locally

steventux · 2024-04-10T13:06:58Z

[SPIKE] Generate PDF certificates in AYTQ

github-actions · 2024-11-15T11:24:17Z

The review apps Access Your Teaching Qualifications & Check A Teacher's Record have been deleted.
The following domains are not available anymore:

Grover turns the html output of the certificates#show action into a PDF response, but we don't want to expose HTML format as a valid response. So limit the route to Grover middleware requests.

gunndabad · 2025-01-16T13:59:46Z

Dockerfile

+
+# Open port 2222 for Azure SSH access
+EXPOSE 2222
+>>>>>>> 5151546 (mend)


Should this line be here?

gunndabad · 2025-01-16T14:00:03Z

Dockerfile

+# SSH access specific to Azure
+# Install OpenSSH and set the password for root to "Docker!".
+RUN apk add --no-cache openssh && echo "root:Docker!" | chpasswd
+
+# Copy the Azure specific sshd_config file to the /etc/ssh/ directory
+RUN ssh-keygen -A && mkdir -p /var/run/sshd
+COPY azure/.sshd_config /etc/ssh/sshd_config
+
+# Open port 2222 for Azure SSH access
+EXPOSE 2222


Not sure any of these lines are required any more.

gunndabad · 2025-01-16T14:21:17Z

app/views/qualifications/certificates/_induction.html.erb

+    institution. The holder of this certificate is a qualified teacher and has obtained the required<br/>
+    qualifications and completed the necessary training for the profession of school teacher in England.</p>
+  <p>&#160;</p>
+  <p class="text">Date Induction Completed:&#160;<strong><%= qualification.details.periods.first.end_date.to_date.to_fs(:long_uk) %></strong></p>


Induction periods are going away from the API very shortly; we should use the dates on the top-level induction property

Should be fixed now

steventux force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 9415d99 to 532072e Compare April 10, 2024 15:36

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from a2a9411 to ca411d5 Compare July 30, 2024 07:34

richardpattinson marked this pull request as ready for review August 6, 2024 13:50

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from ca411d5 to 1f62c85 Compare November 12, 2024 16:00

richardpattinson added the deploy-aks label Nov 12, 2024

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch 4 times, most recently from 4ffad25 to aabf6ad Compare November 15, 2024 09:06

richardpattinson added deploy-aks deploy and removed deploy-aks labels Nov 15, 2024

richardpattinson temporarily deployed to review November 15, 2024 11:20 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from aabf6ad to 737a288 Compare November 15, 2024 15:54

richardpattinson temporarily deployed to review November 15, 2024 15:56 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 737a288 to a6cfb37 Compare November 15, 2024 16:03

richardpattinson temporarily deployed to review November 15, 2024 16:05 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from a6cfb37 to 3704790 Compare November 15, 2024 16:20

richardpattinson temporarily deployed to review November 15, 2024 16:22 — with GitHub Actions Inactive

richardpattinson added deploy and removed deploy labels Nov 20, 2024

richardpattinson temporarily deployed to review November 20, 2024 16:44 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from e5f06a1 to 2badc65 Compare November 20, 2024 16:58

richardpattinson temporarily deployed to review November 20, 2024 17:00 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 2badc65 to 12b0588 Compare November 20, 2024 17:09

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch 2 times, most recently from c9c45a8 to 4d0bde2 Compare January 15, 2025 15:54

richardpattinson temporarily deployed to review January 15, 2025 15:57 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 4d0bde2 to 8ec8b12 Compare January 15, 2025 15:58

richardpattinson temporarily deployed to review January 15, 2025 16:01 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 8ec8b12 to da419c5 Compare January 16, 2025 13:08

richardpattinson temporarily deployed to review January 16, 2025 13:10 — with GitHub Actions Inactive

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from da419c5 to 5151546 Compare January 16, 2025 13:34

richardpattinson temporarily deployed to review January 16, 2025 13:36 — with GitHub Actions Inactive

steventux and others added 8 commits January 16, 2025 13:44

Add grover gem

eb2ffb3

Add puppeteer chromium headless dependency

96b20bf

Configure grover

5ed61cb

Render certificate as PDF

dac8f6e

Make pdf generation ignore non-certificate paths

15ac2fa

Add assets for different certificate formats

15b8481

Restrict certificates route to Grover middleware

a949845

Grover turns the html output of the certificates#show action into a PDF response, but we don't want to expose HTML format as a valid response. So limit the route to Grover middleware requests.

Wip

31356c3

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 5151546 to 7715629 Compare January 16, 2025 13:45

gunndabad reviewed Jan 16, 2025

View reviewed changes

Dockerfile Outdated

# Open port 2222 for Azure SSH access

EXPOSE 2222

>>>>>>> 5151546 (mend)

Copy link

Contributor

gunndabad Jan 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this line be here?

gunndabad reviewed Jan 16, 2025

View reviewed changes

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 7715629 to 63fc0a9 Compare January 16, 2025 14:09

richardpattinson temporarily deployed to review January 16, 2025 14:15 — with GitHub Actions Inactive

gunndabad reviewed Jan 16, 2025

View reviewed changes

mend

216ba81

richardpattinson force-pushed the 1980-spike-generate-pdf-certificates-in-aytq branch from 63fc0a9 to 216ba81 Compare January 16, 2025 14:30

gunndabad approved these changes Jan 16, 2025

View reviewed changes

richardpattinson temporarily deployed to review January 16, 2025 14:34 — with GitHub Actions Inactive

richardpattinson merged commit 5500e44 into main Jan 16, 2025
10 checks passed

richardpattinson deleted the 1980-spike-generate-pdf-certificates-in-aytq branch January 16, 2025 14:37

richardpattinson temporarily deployed to review January 16, 2025 14:37 — with GitHub Actions Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Spike] Generate PDF Certificates #625

[Spike] Generate PDF Certificates #625

steventux commented Apr 10, 2024 •

edited by richardpattinson

Loading

steventux commented Apr 10, 2024

github-actions bot commented Nov 15, 2024 •

edited

Loading

gunndabad Jan 16, 2025

gunndabad Jan 16, 2025

gunndabad Jan 16, 2025

richardpattinson Jan 16, 2025

[Spike] Generate PDF Certificates #625

[Spike] Generate PDF Certificates #625

Conversation

steventux commented Apr 10, 2024 • edited by richardpattinson Loading

Context

Changes proposed in this pull request

TODO:

Guidance to review

Link to Trello card

Checklist

steventux commented Apr 10, 2024

github-actions bot commented Nov 15, 2024 • edited Loading

gunndabad Jan 16, 2025

Choose a reason for hiding this comment

gunndabad Jan 16, 2025

Choose a reason for hiding this comment

gunndabad Jan 16, 2025

Choose a reason for hiding this comment

richardpattinson Jan 16, 2025

Choose a reason for hiding this comment

steventux commented Apr 10, 2024 •

edited by richardpattinson

Loading

github-actions bot commented Nov 15, 2024 •

edited

Loading